This repository was archived by the owner on Mar 10, 2020. It is now read-only.
chore: Add api path docs and test #767
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ghost
assigned 
alanshaw
reviewed
May 18, 2018
| clientWorks(ipfsAPI({ | ||
| host: splitted[2], | ||
| port: splitted[4], | ||
| 'api-path': '/api/v0/' |
There was a problem hiding this comment.
Since this is the default, this test doesn't really prove anything except for you can pass api-path as an option without it breaking.
Ideally we'd actually setup a proxy for the test and point the API at the proxy with api-path: '/ipfs/api/v0'. Obviously this wouldn't be possible in the browser so you'd need to skip.
I'd accept a PR for that!
alanshaw
approved these changes
May 18, 2018
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
After @alanshaw suggestion, I added docs and a test for the
api-pathusage in the API constructor.Closes #581